/** @file
  Super I/O Interface function declarations.

 @copyright
  INTEL CONFIDENTIAL
  Copyright 2010 - 2016 Intel Corporation.

  The source code contained or described herein and all documents related to the
  source code ("Material") are owned by Intel Corporation or its suppliers or
  licensors. Title to the Material remains with Intel Corporation or its suppliers
  and licensors. The Material may contain trade secrets and proprietary and
  confidential information of Intel Corporation and its suppliers and licensors,
  and is protected by worldwide copyright and trade secret laws and treaty
  provisions. No part of the Material may be used, copied, reproduced, modified,
  published, uploaded, posted, transmitted, distributed, or disclosed in any way
  without Intel's prior express written permission.

  No license under any patent, copyright, trade secret or other intellectual
  property right is granted to or conferred upon you by disclosure or delivery
  of the Materials, either expressly, by implication, inducement, estoppel or
  otherwise. Any license under such intellectual property rights must be
  express and approved by Intel in writing.

  Unless otherwise agreed by Intel in writing, you may not remove or alter
  this notice or any other notice embedded in Materials by Intel or
  Intel's suppliers or licensors in any way.

  This file contains 'Framework Code' and is licensed as such under the terms
  of your license agreement with Intel or your vendor. This file may not be 
  modified, except as allowed by additional terms of your license agreement.

@par Specification Reference:
**/

#ifndef _SIO_ACPI_H_
#define _SIO_ACPI_H_

//
// Prototypes for the SIO protocol interface
//


/**
  Provides an interface to get a list of the current resources consumed by the device in the ACPI
  Resource Descriptor format.

  GetResources() returns a list of resources currently consumed by the device. The
  ResourceList is a pointer to the buffer containing resource descriptors for the device. The
  descriptors are in the format of Small or Large ACPI resource descriptor as defined by ACPI
  specification (2.0 & 3.0). The buffer of resource descriptors is terminated with the 'End tag'
  resource descriptor.

  @param[in]    This                  Indicates a pointer to the calling context.
  @param[out]   ResourceList          A pointer to an ACPI resource descriptor list that defines the current resources
                                      used by the device. Type ACPI_RESOURCE_HEADER_PTR is defined in the "Related
                                      Definitions" below.

  @retval       EFI_SUCCESS           The operation completed successfully
  @retval       EFI_INVALID_PARAMETER ResourceList is NULL
**/
EFI_STATUS
EFIAPI
SioGetResources (
  IN  CONST EFI_SIO_PROTOCOL    *This,
  OUT ACPI_RESOURCE_HEADER_PTR  *ResourceList
  );


/**
  Sets the resources for the device.

  @param[in]  This                  Indicates a pointer to the calling context.
  @param[in]  ResourceList          Pointer to the ACPI resource descriptor list. Type ACPI_RESOURCE_HEADER_PTR
                                    is defined in the "Related Definitions" section of
                                    EFI_SIO_PROTOCOL.GetResources().

  @retval     EFI_SUCCESS           The operation completed successfully
  @retval     EFI_INVALID_PARAMETER ResourceList is invalid
  @retval     EFI_ACCESS_DENIED     Some of the resources in ResourceList are in use
**/
EFI_STATUS
EFIAPI
SioSetResources (
  IN  CONST EFI_SIO_PROTOCOL    *This,
  IN  ACPI_RESOURCE_HEADER_PTR  ResourceList
  );


/**
  Provides a collection of resource descriptor lists. Each resource descriptor list in the collection
  defines a combination of resources that can potentially be used by the device.

  @param[in]  This                      Indicates a pointer to the calling context.
  @param[out] ResourceCollection        Collection of the resource descriptor lists.

  @retval     EFI_SUCCESS               The operation completed successfully
  @retval     EFI_INVALID_PARAMETER     ResourceCollection is NULL
**/
EFI_STATUS
EFIAPI
SioPossibleResources (
  IN  CONST EFI_SIO_PROTOCOL    *This,
  OUT ACPI_RESOURCE_HEADER_PTR  *ResourceCollection
  );


/**
  Provides a low level access to the registers for the Super I/O.

  @param[in]        This                  Indicates a pointer to the calling context.
  @param[in]        Write                 Specifies the type of the register operation. If this parameter is TRUE,
                                          Value is interpreted as an input parameter and the operation is a register write.
                                          If this parameter is FALSE, Value is interpreted as an output parameter and the
                                          operation is a register read.
  @param[in]        ExitCfgMode           Exit Configuration Mode Indicator. If this parameter is set to TRUE, the 
                                          Super I/O driver will turn off configuration mode of the Super I/O prior to returning
                                          from this function. If this parameter is set to FALSE, the Super I/O driver will
                                          leave Super I/O in the configuration mode.
                                          The Super I/O driver must track the current state of the Super I/O and enable the
                                          configuration mode of Super I/O if necessary prior to register access.
  @param[in]        Register              Register number.
  @param[in, out]   Value                 If Write is TRUE, Value is a pointer to the buffer containing the byte of data to be
                                          written to the Super I/O register. If Write is FALSE, Value is a pointer to the
                                          destination buffer for the byte of data to be read from the Super I/O register.

  @retval           EFI_SUCCESS           The operation completed successfully
  @retval           EFI_INVALID_PARAMETER The Value is NULL
  @retval           EFI_INVALID_PARAMETER Invalid Register number
**/
EFI_STATUS
EFIAPI
SioRegisterAccess (
  IN CONST EFI_SIO_PROTOCOL    *This,
  IN BOOLEAN                   Write,
  IN BOOLEAN                   ExitCfgMode,
  IN UINT8                     Register,
  IN OUT UINT8                 *Value
  );


/**
  Provides an interface for a table based programming of the Super I/O registers.

  The Modify() function provides an interface for table based programming of the Super I/O
  registers. This function can be used to perform programming of multiple Super I/O registers with a
  single function call. For each table entry, the Register is read, its content is bitwise ANDed with
  AndMask, and then ORed with OrMask before being written back to the Register. The Super
  I/O driver must track the current state of the Super I/O and enable the configuration mode of Super I/
  O if necessary prior to table processing. Once the table is processed, the Super I/O device has to be
  returned to the original state.

  @param[in] This                  Indicates a pointer to the calling context.
  @param[in] Command               A pointer to an array of NumberOfCommands EFI_SIO_REGISTER_MODIFY
                                   structures. Each structure specifies a single Super I/O register modify operation.
                                   Type EFI_SIO_REGISTER_MODIFY is defined in the "Related Definitions" below.
  @param[in] NumberOfCommands      Number of elements in the Command array.
  
  @retval    EFI_SUCCESS           The operation completed successfully
  @retval    EFI_INVALID_PARAMETER Command is NULL
**/
EFI_STATUS
EFIAPI
SioModify (
  IN CONST EFI_SIO_PROTOCOL        *This,
  IN CONST EFI_SIO_REGISTER_MODIFY *Command,
  IN UINTN                         NumberOfCommands
  );

#endif
